fix: format stray markdown files and correct broken link breaking CI on main by ihabadham · Pull Request #3301 · shakacode/react_on_rails

ihabadham · 2026-05-15T16:44:18Z

Summary

Two markdown files were merged to main without passing the repo-wide checks, which turns markdown-format-check and the build job's format step red on every open PR (both run prettier --check over the entire repo, not just changed files):

internal/planning/json-render-body-migration-plan.md (from docs(planning): JSON render-request body migration plan (#3280) #3299) — prettier formatting only.
reports/ror-memory-leakage-investigation.md (from docs: memory leakage investigation report for SSR pipeline #3296) — prettier formatting and a relative link to ../../docs/pro/js-memory-leaks.md, which is one level too high and resolves outside the repo. The target exists at repo-root docs/pro/js-memory-leaks.md; corrected to ../docs/pro/js-memory-leaks.md.

Formatting changes are prettier --write output only (no content edits). The link change is a single relative-path correction; verified the target file exists and the markdown-links (lychee) pre-commit hook now passes.

Why this is its own PR

These files are unrelated to any feature work, but their CI failures block unrelated PRs (e.g. #3232). Fixing them on main directly via a focused PR unblocks everything in flight.

Test plan

pnpm exec prettier --check internal/planning/json-render-body-migration-plan.md reports/ror-memory-leakage-investigation.md → clean
markdown-links lefthook hook passes (corrected link resolves)
No content changes beyond the one relative-path fix

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Updated planning documentation with status updates for related pull requests and issue tracking
- Enhanced investigation report with improved structure and readability through reformatted content into consistent table formats

Two files merged to main without passing the repo-wide checks: - internal/planning/json-render-body-migration-plan.md (#3299) — failed prettier formatting. - reports/ror-memory-leakage-investigation.md (#3296) — failed prettier formatting AND linked to ../../docs/pro/js-memory-leaks.md, one level too high (resolves outside the repo). Target exists at repo-root docs/pro/js-memory-leaks.md; corrected to ../docs/pro/js-memory-leaks.md. The markdown-format-check and build CI jobs run prettier --check over the whole repo, so every open PR fails those checks until these are fixed. Formatting changes are prettier --write output only; the link change is a single relative-path correction. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-05-15T16:44:33Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1d375ce6-79ac-48d7-863f-27f95a7de99f

📥 Commits

Reviewing files that changed from the base of the PR and between fd9feb5 and de23b7e.

📒 Files selected for processing (2)

internal/planning/json-render-body-migration-plan.md
reports/ror-memory-leakage-investigation.md

Walkthrough

This PR restructures two documentation files by updating planning document table entries and converting the memory leakage investigation report from inline content into consistently formatted markdown tables to improve readability and information organization.

Changes

Documentation Restructuring

Layer / File(s)	Summary
Planning document artifact and status links `internal/planning/json-render-body-migration-plan.md`	Links table entries for issue `#3280` experiment/branch details are re-aligned; the "Status of related PRs" table is updated for PRs `#3293`, `#3298`, and the current PR.
Memory report verification rubric and architecture section `reports/ror-memory-leakage-investigation.md`	Verification Rubric section is converted to a formatted table; Memory-Relevant Architecture Details section is adjusted with Ruby-side and Node-side formatting; spacing adjustments improve visual separation.
Memory report experiment documentation refactoring `reports/ror-memory-leakage-investigation.md`	Experiments 1–3 documentation is reworked into structured tables showing parameters and verdicts; spacing lines are added before key observations and HTTP/2 amplification bullets.
Memory report diagnostic and analysis tables `reports/ror-memory-leakage-investigation.md`	Fragmentation vs Leak diagnostic distinction is reformatted into a table; "Why the Leak Cannot Be Reproduced" subsections are made more consistent; Node-side Common Application-Level Leak Patterns section is converted to a table with pattern/mechanism/severity.
Memory report recommendations and appendix data tables `reports/ror-memory-leakage-investigation.md`	Worker Rolling Restarts configuration formatting is adjusted; documentation link for "Avoiding Memory Leaks in Node Renderer SSR" is updated; appendix raw experiment data sections are reformatted into markdown tables.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

shakacode/react_on_rails#3299: Both PRs modify the same internal/planning/json-render-body-migration-plan.md document with table updates for issues #3280, #3293, and #3298.

Poem

📋 Tables now reign where prose once sprawled,
A rabbit's touch made order called;
Links align, diagnostics gleam,
Data structured—a cleaner scheme. 🐰

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the primary changes: formatting markdown files and correcting a broken link that causes CI failures.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch ihabadham/fix/format-stray-markdown

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

greptile-apps · 2026-05-15T16:45:20Z

Greptile Summary

This PR fixes two markdown files that were breaking CI on main by failing the repo-wide prettier --check step, and corrects a broken relative link in the memory-leakage report.

internal/planning/json-render-body-migration-plan.md: Prettier table-formatting alignment only — no content changes.
reports/ror-memory-leakage-investigation.md: Prettier formatting across all tables and paragraphs, plus a one-level relative-path correction (../../docs/pro/... → ../docs/pro/...) that now correctly resolves to the existing docs/pro/js-memory-leaks.md at the repo root.

Confidence Score: 5/5

Safe to merge — changes are whitespace-only formatting and a single link path correction.

Both files receive only Prettier-generated whitespace realignment in tables and paragraph spacing. The one substantive change is the relative link in reports/ror-memory-leakage-investigation.md, corrected from ../../docs/pro/js-memory-leaks.md to ../docs/pro/js-memory-leaks.md; the target file is confirmed to exist at docs/pro/js-memory-leaks.md in the repo root, making the fix accurate.

No files require special attention.

Important Files Changed

Filename	Overview
internal/planning/json-render-body-migration-plan.md	Prettier table column-width alignment only; no content or link changes.
reports/ror-memory-leakage-investigation.md	Prettier formatting across tables and paragraphs, plus one broken relative-link fix (`../../` → `../`); target file confirmed to exist at `docs/pro/js-memory-leaks.md`.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["CI on main (broken)"] -->|"prettier --check fails"| B["json-render-body-migration-plan.md\n(misaligned table columns)"]
    A -->|"prettier --check + broken link"| C["ror-memory-leakage-investigation.md\n(misaligned tables + ../../docs/... link)"]
    B -->|"prettier --write"| D["Formatted ✓"]
    C -->|"prettier --write"| E["Formatted ✓"]
    C -->|"../../docs/pro/js-memory-leaks.md\n→ ../docs/pro/js-memory-leaks.md"| F["Link resolved ✓"]
    D --> G["CI green on main"]
    E --> G
    F --> G

_{Reviews (1): Last reviewed commit: "fix: format stray markdown and correct a..." | Re-trigger Greptile}

claude · 2026-05-15T16:45:39Z

Code Review

Summary: Focused maintenance PR fixing two CI-blocking issues — Prettier formatting violations and a broken relative link — introduced by earlier merges (#3299, #3296).

What the PR does

Prettier formatting on internal/planning/json-render-body-migration-plan.md and reports/ror-memory-leakage-investigation.md — purely mechanical column-alignment in GFM tables and consistent _italic_ normalization, no content changes.
Broken link fix in reports/ror-memory-leakage-investigation.md: ../../docs/pro/js-memory-leaks.md → ../docs/pro/js-memory-leaks.md.

Verification

Link correction is accurate. The report lives at reports/ror-memory-leakage-investigation.md, so one level up (../) reaches the repo root. The target docs/pro/js-memory-leaks.md exists at that location. The original two-level ../../ path would escape the repository entirely.
Formatting changes match Prettier output per the repo's .prettierrc (printWidth 110, etc.). No content was altered.
Scope is minimal — only the two files that caused CI failures are touched.

Assessment

No logic, code, or content changes — purely formatting and a single path correction.
The link fix is the only substantive change, and it is correct.
No security, performance, or test-coverage concerns apply to documentation-only changes.

Verdict: LGTM. Clean, minimal fix that unblocks CI for all open PRs without any risk of regression.

coderabbitai Bot approved these changes May 15, 2026

View reviewed changes

ihabadham merged commit 2f0b077 into main May 15, 2026
11 checks passed

ihabadham deleted the ihabadham/fix/format-stray-markdown branch May 15, 2026 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: format stray markdown files and correct broken link breaking CI on main#3301

fix: format stray markdown files and correct broken link breaking CI on main#3301
ihabadham merged 1 commit into
mainfrom
ihabadham/fix/format-stray-markdown

ihabadham commented May 15, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented May 15, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot commented May 15, 2026

Uh oh!

claude Bot commented May 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

ihabadham commented May 15, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why this is its own PR

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

greptile-apps Bot commented May 15, 2026

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

claude Bot commented May 15, 2026

Code Review

What the PR does

Verification

Assessment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

ihabadham commented May 15, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 15, 2026 •

edited

Loading